Skip to main content

dropboxRelinquishFolderMembership

Type​

command

Summary​

The current user relinquishes their membership in the designated shared folder and will no longer have access to the folder.

Syntax​

dropboxRelinquishFolderMembership <pAccessToken>, <pSharedFolderId>, <pLeaveACopy>, [<pCallback>]

Description​

A folder owner cannot relinquish membership in their own folder. This will run synchronously if leave_a_copy is false, and asynchronously if leave_a_copy is true. Apps must have full Dropbox access to use this endpoint.

If the callback parameter is not empty the request will be asynchronus and when complete the callback will be sent to the object that accessed the API. The callback will be sent with three parameters:

  • The request ID which will be the value of the it variable after calling the command
  • The HTTP response code
  • The data returned which will be the same data as documented for the it variable in a synchronous request.

Parameters​

NameTypeDescription

pAccessToken

An OAuth2 Access token to access the user's account

pSharedFolderId

The ID for the shared folder.

pLeaveACopy

Keep a copy of the folder's contents upon relinquishing membership. The default for this field is False.

pCallback

The handler to call when the request is complete. If empty the command will block until complete.